Resource URL: /platform/<<version=1>>/auth/groups/<GROUP>

    Overview: This resource applies the standard collection pattern to
              individual groups.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve the group information.

       URL: GET /platform/<<version=1>>/auth/groups/<GROUP>

Query arguments:
       cached=<boolean> If true, only return cached objects.
resolve_names=<boolean> Resolve names of personas.
          zone=<string> Filter groups by zone.
      provider=<string> Filter groups by provider.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "groups": {
      "items": {
        "type": "object", 
        "description": "Specifies configuration properties for a group.", 
        "properties": {
          "dn": {
            "required": true, 
            "type": [
              "string", 
              "null"
            ], 
            "description": "Specifies the distinguished name for the user."
          }, 
          "domain": {
            "required": true, 
            "type": [
              "string", 
              "null"
            ], 
            "description": "Specifies the domain that the object is part of."
          }, 
          "generated_gid": {
            "required": true, 
            "type": [
              "boolean", 
              "null"
            ], 
            "description": "If true, the GID was generated."
          }, 
          "name": {
            "required": true, 
            "type": "string", 
            "description": "Specifies a user or group name."
          }, 
          "member_of": {
            "required": true, 
            "type": [
              {
                "type": "null"
              }, 
              {
                "items": {
                  "type": "object", 
                  "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                  "properties": {
                    "type": {
                      "enum": [
                        "user", 
                        "group", 
                        "wellknown"
                      ], 
                      "type": "string", 
                      "description": "Specifies the type of persona, which must be combined with a name."
                    }, 
                    "id": {
                      "type": "string", 
                      "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                    }, 
                    "name": {
                      "type": "string", 
                      "description": "Specifies the persona name, which must be combined with a type."
                    }
                  }
                }, 
                "type": "array"
              }
            ], 
            "description": "Specifies the groups that this user or group are members of."
          }, 
          "sid": {
            "required": true, 
            "type": [
              {
                "type": "object", 
                "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                "properties": {
                  "type": {
                    "enum": [
                      "user", 
                      "group", 
                      "wellknown"
                    ], 
                    "type": "string", 
                    "description": "Specifies the type of persona, which must be combined with a name."
                  }, 
                  "id": {
                    "type": "string", 
                    "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                  }, 
                  "name": {
                    "type": "string", 
                    "description": "Specifies the persona name, which must be combined with a type."
                  }
                }
              }
            ], 
            "description": "Specifies the security identifier."
          }, 
          "dns_domain": {
            "required": true, 
            "type": [
              "string", 
              "null"
            ], 
            "description": "Specifies the DNS domain."
          }, 
          "sam_account_name": {
            "required": true, 
            "type": [
              "string", 
              "null"
            ], 
            "description": "Specifies a user or group name."
          }, 
          "gid": {
            "required": true, 
            "type": [
              {
                "type": "object", 
                "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                "properties": {
                  "type": {
                    "enum": [
                      "user", 
                      "group", 
                      "wellknown"
                    ], 
                    "type": "string", 
                    "description": "Specifies the type of persona, which must be combined with a name."
                  }, 
                  "id": {
                    "type": "string", 
                    "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                  }, 
                  "name": {
                    "type": "string", 
                    "description": "Specifies the persona name, which must be combined with a type."
                  }
                }
              }, 
              {
                "type": "null"
              }
            ], 
            "description": "Specifies the numeric group identifier."
          }, 
          "provider": {
            "required": true, 
            "type": [
              "string", 
              "null"
            ], 
            "description": "Specifies the authentication provider that the object belongs to."
          }, 
          "type": {
            "required": true, 
            "type": "string", 
            "description": "Specifies the object type."
          }, 
          "id": {
            "required": true, 
            "type": "string", 
            "description": "Specifies the user or group ID."
          }
        }
      }, 
      "type": "array"
    }
  }
}

********************************************************************************

Method PUT: Modify the group.

       URL: PUT /platform/<<version=1>>/auth/groups/<GROUP>

Query arguments:
    zone=<string> Optional zone.
provider=<string> Optional provider type.

PUT request body schema:
{
  "type": "object", 
  "description": "Specifies the configuration properties for a group.", 
  "properties": {
    "gid": {
      "type": "integer", 
      "description": "Specifies the numeric group identifier."
    }
  }
}

There is no response body for this method.

********************************************************************************

Method DELETE: Delete the group.

          URL: DELETE /platform/<<version=1>>/auth/groups/<GROUP>

Query arguments:
 cached=<boolean> If true, flush the group from the cache.
    zone=<string> Filter groups by zone.
provider=<string> Filter groups by provider.

There is no response body for this method.
